home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 June / EnigmA AMIGA RUN 08 (1996)(G.R. Edizioni)(IT)[!][issue 1996-06][EARSAN CD VII].iso / earcd / utmisc1 / ovr50711.lha / Over5 / doc / Over5.doc < prev    next >
Text File  |  1996-05-12  |  10KB  |  406 lines
  1. Documentation for Over5 0.711 by Daniel Kahlin <tlr@stacken.kth.se>
  2. -----------------------------------------------------------------------------
  3. Copyright (c) 1995,1996 Daniel Kahlin <tlr@stacken.kth.se>
  4.  
  5. Distribution:
  6.  
  7.   Over5 is FREEWARE (Freely-Distributable), but copyrighted by me. (NOT PD!) 
  8. None of the included files may be modified and/or removed.  Permission is
  9. given to freely distribute this program provided you include all files from
  10. the original archive, and no fee is charged in excess of reasonable media
  11. and mailing costs.  The program may not be used for commercial purposes
  12. without written permission from the author.
  13.  
  14.  
  15. Disclaimer:
  16.  
  17.   I cannot in any way be held responsible for anything this program does.
  18. You are using it entirely at your own risk.  Every effort has been made to
  19. keep this program bug free.  But, IF for example a bug exists that blows up
  20. your entire computer, don't blame me.
  21.  
  22. -----------------------------------------------------------------------------
  23.  
  24. Over5 on the WWW: (contains the latest release)
  25.   http://www.stacken.kth.se/~tlr/computing/over5.html
  26.  
  27. GENERAL:
  28.  
  29.   Over5 (the successor to OverFour) is an AMIGA to/from C64 transfer program
  30. package.  It was made because of too many burnt 6526's and 8520's.  To
  31. overcome that problem I chose to use a standard RS-232 interface.
  32.  
  33. Over5 contains several commands:  COPY, WRITEFILE, READFILE, WRITEMEM,
  34.   READMEM, SYS, RUN, RESET, SIMPLEWRITE, SIMPLEREAD, BOOT, DIR, STATUS,
  35.   COMMAND, WRITEDISK, READDISK, WRITEZIP, READZIP, TEST, SERVER, HELP.
  36.  
  37. CONFIG FILE:
  38. ------------
  39.   At startup Over5 tries to load the file 'PROGDIR:Over5.config'.
  40. Here is an example config containing the default values:
  41.  
  42. --------------------
  43.  
  44. ;
  45. ; over5.config
  46. ; comment
  47. # comment
  48. ;
  49. DEVICE=8    ;cbm device number
  50. SERIALDEVICE=serial.device
  51. SERIALUNIT=0
  52. #
  53. # end of file
  54. #
  55. --------------------
  56.  
  57.  
  58. NUMBER INPUT:
  59. -------------
  60.   Most parameters which expects a number can be fed with different
  61. radixes.  The default radix for addresses is 16 (hex).  For device
  62. numbers the default is 10 (dec).
  63.  
  64. prefixes:
  65.   '%'       binary  (ex: %11001)
  66.   '$','0x'  hexadecimal  (ex: $ef, 0xfce2)
  67.   '@'       octal (ex: @377)
  68.   '+', '#'  decimal (ex: +255, #16)
  69.  
  70. (the prefix is ofcourse only necessary if the wanted radix differs from
  71.  the default radix.)
  72.  
  73.  
  74.  
  75. THE COMMANDS:
  76. -------------
  77.  
  78.  
  79. command COPY:
  80. -------------
  81.  
  82. TEMPLATE: Over5 COPY FROM/M,TO/A,DEBUG/S
  83.  
  84.   FROM/M    source file/files 
  85.   TO/A      destination file/path
  86.   DEBUG/S   sets debug mode (shows all packets).
  87.  
  88. copies source to destination (like AmigaDOS copy) but '<devnum>:'
  89. is the cbm drive. (ex. '8:','9:')
  90. Wildcards are fully supported.  Cbm filenames may end with ',<s|p|u|r>'
  91. which indicates SEQ/PRG/USR/REL files. (the default is ',p')  When
  92. wildcards are used with cbm files, only the filetype specified matches.
  93.  
  94. examples:
  95.  
  96. > Over5 COPY 8:a#?.src,s ram:
  97. will copy cbm files like 'APA.SRC' and 'AFFE.SRC' (SEQ) to 'ram:apa.src'
  98. and 'ram:affe.src'.
  99.  
  100. > Over5 COPY work:c64/dl_demos/#?.tlr 8:
  101. will copy 'work:c64/dl_demos/neat-oh.tlr' to the cbm file 'NEAT-OH.TLR'
  102. (PRG).
  103.  
  104. > Over5 COPY mysource.asm 8:,s
  105. will copy 'mysource.asm' to the cbm file 'MYSOURCE.ASM' (SEQ).
  106.  
  107. > Over5 COPY #?(.asm|.i) 8:,u
  108. will copy files like 'one.asm' and 'two.i' to the cbm files 'ONE.ASM'
  109. (USR) and 'TWO.I' (USR).
  110.  
  111.  
  112. command WRITEFILE:
  113. ------------------
  114. (this is a low level command, generally you should use 'COPY' instead)
  115.  
  116. TEMPLATE: Over5 WRITEFILE FROM/A,TO/A,DEVICE/N,DEBUG/S
  117.  
  118.   FROM/A    source file 
  119.   TO/A      destination file
  120.   DEVICE/N  1541 device number
  121.   DEBUG/S   sets debug mode (shows all packets).
  122.  
  123. copies source file from the amiga to the destination file on the 1541.
  124.  
  125.  
  126. command READFILE:
  127. -----------------
  128. (this is a low level command, generally you should use 'COPY' instead)
  129.  
  130. TEMPLATE: Over5 READFILE FROM/A,TO/A,DEVICE/N,DEBUG/S
  131.  
  132.   FROM/A    source file 
  133.   TO/A      destination file
  134.   DEVICE/N  1541 device number
  135.   DEBUG/S   sets debug mode (shows all packets).
  136.  
  137. copies source file from the 1541 to the destination file on the amiga.
  138.  
  139.  
  140. command WRITEMEM:
  141. ------------------
  142.  
  143. TEMPLATE: Over5 WRITEMEM FROM/A,NEWADDR,RUN/S,RESET/S,DEBUG/S
  144.  
  145.   FROM/A    source file 
  146.   NEWADDR   optional load address
  147.   RUN/S     execute file with 'RUN' after transfer.
  148.   RESET/S   do reset on the c64 before transfer (with special hardware)
  149.   DEBUG/S   sets debug mode (shows all packets).
  150.  
  151. Writes source file into the c64 memory.
  152.  
  153.  
  154. command READMEM:
  155. ----------------
  156.  
  157. TEMPLATE: Over5 READMEM START/A,END/A,TO/A,RESET/S,DEBUG/S
  158.  
  159.   START/A   start address
  160.   END/A     end address
  161.   TO/A      destination file 
  162.   RESET/S   do reset on the c64 before transfer (with special hardware)
  163.   DEBUG/S   sets debug mode (shows all packets).
  164.  
  165. Reads c64 memory between START and END to the destination file.
  166.  
  167.  
  168. command SYS:
  169. ------------
  170.  
  171. TEMPLATE: Over5 SYS PC/A,MEMORY,SR,AC,XR,YR,SP,RESET/S,DEBUG/S
  172.  
  173.   PC/A      programcounter
  174.   MEMORY    contents of $01  (default 0x37)
  175.   SR        status register  (default 0x00)
  176.   AC        Accumulator      (default 0x00)
  177.   XR        X index register (default 0x00)
  178.   YR        Y index register (default 0x00)
  179.   SP        Stack pointer    (default 0xff)
  180.   RESET/S   do reset on the c64 before sys (with special hardware)
  181.   DEBUG/S   sets debug mode (shows all packets).
  182.  
  183. Starts code beginning at pc.
  184.  
  185.  
  186. command RUN:
  187. ------------
  188.  
  189. TEMPLATE: Over5 RUN DEBUG/S
  190.  
  191.   DEBUG/S   sets debug mode (shows all packets).
  192.  
  193. Not yet implemented!
  194.  
  195.  
  196. command RESET:
  197. --------------
  198.  
  199. TEMPLATE: Over5 RESET DEBUG/S
  200.  
  201.   DEBUG/S   sets debug mode (shows all packets).
  202.  
  203. does reset on the c64 (with special hardware)
  204.  
  205.  
  206.  
  207. command SIMPLEWRITE:
  208. --------------------
  209.  
  210. TEMPLATE: Over5 SIMPLEWRITE FROM/A,OLD/S
  211.  
  212.   FROM/A    source file 
  213.   OLD/S     obsolete protocol. use for FastRS 1.1 or earlier
  214.  
  215. Writes source file into the c64 memory using the simpleprotocol.
  216. (no handshaking)
  217.  
  218.  
  219. command SIMPLEREAD:
  220. -------------------
  221.  
  222. TEMPLATE: Over5 SIMPLEREAD TO/A,OLD/S
  223.  
  224.   TO/A      destination file 
  225.   OLD/S     obsolete protocol. Use this for FastRS 1.1 or earlier.
  226.  
  227. Reads source file from the c64 memory using the simpleprotocol.
  228. (no handshaking)
  229.  
  230.  
  231. command BOOT:
  232. -------------
  233. (this is only used to transfer 'DiskSlave' or similar for the first time)
  234.  
  235. TEMPLATE: Over5 BOOT FROM/A,SAFEADDR,OLD/S
  236.  
  237.   FROM/A    source file 
  238.   SAFEADDR  optional safeaddr for use with VIC-20 (default $c000)
  239.             (only has meaning is OLD is specified)
  240.   OLD/S     use old protocol
  241.  
  242. See 'README.INSTALLING' and 'boot.tech' for details.
  243.  
  244.  
  245. command DIR:
  246. ------------
  247.  
  248. TEMPLATE: Over5 DIR DEVICE/N,DEBUG/S
  249.  
  250.   DEVICE/N  1541 device number
  251.   DEBUG/S   sets debug mode (shows all packets).
  252.  
  253. Reads directory from the 1541 and shows it.
  254.  
  255.  
  256. command STATUS:
  257. ---------------
  258.  
  259. TEMPLATE: Over5 STATUS DEVICE/N,DEBUG/S
  260.  
  261.   DEVICE/N  1541 device number
  262.   DEBUG/S   sets debug mode (shows all packets).
  263.  
  264. Gets diskstatus from 1541 and shows it.
  265.  
  266.  
  267. command COMMAND:
  268. ----------------
  269.  
  270. TEMPLATE: Over5 COMMAND COMMAND/A,DEVICE/N,DEBUG/S
  271.  
  272.   COMMAND/A diskcommand
  273.   DEVICE/N  1541 device number
  274.   DEBUG/S   sets debug mode (shows all packets).
  275.  
  276. Sends a diskcommand to the 1541.
  277.  
  278.  
  279. command TEST:
  280. -------------
  281. (this command is not necessary for the ordinary user)
  282.  
  283. TEMPLATE: Over5 TEST BLOCK/S,FILE/S,DEBUG/S
  284.  
  285.   BLOCK/S   test block transfer
  286.   FILE/S    test file transfer
  287.   DEBUG/S   sets debug mode (shows all packets).
  288.  
  289. Tests block transfer and/or file transfer.
  290.  
  291.  
  292.  
  293.  
  294. command WRITEDISK:
  295. ------------------
  296.  
  297. TEMPLATE: Over5 WRITEDISK FROM/A,DEVICE/N,DEBUG/S
  298.  
  299.   FROM/A    source diskimage
  300.   DEVICE/N  1541 device number
  301.   DEBUG/S   sets debug mode (shows all packets).
  302.  
  303. Writes the source diskimage to the 1541.  Diskimages are usually
  304. named '.dsk' or '.d64' and should be 174848 bytes in size.
  305.  
  306.  
  307. command WRITEZIP:
  308. -----------------
  309.  
  310. TEMPLATE: Over5 WRITEZIP FROM/A,DEVICE/N,DEBUG/S
  311.  
  312.   FROM/A    zipcode basename (1!<basename>, 2!<basename>, etc...)
  313.   DEVICE/N  1541 device number
  314.   DEBUG/S   sets debug mode (shows all packets).
  315.  
  316. Decodes the zipcode archive and writes the diskimage to the 1541.
  317.  
  318.  
  319.  
  320. command READDISK:
  321. -----------------
  322.  
  323. TEMPLATE: Over5 READDISK TO/A,DEVICE/N,DEBUG/S
  324.  
  325.   TO/A      destination diskimage 
  326.   DEVICE/N  1541 device number
  327.   DEBUG/S   sets debug mode (shows all packets).
  328.  
  329. Reads an entire disk from the 1541.
  330.  
  331.  
  332.  
  333. command READZIP:
  334. ----------------
  335.  
  336. TEMPLATE: Over5 READZIP TO/A,DEVICE/N,DEBUG/S
  337.  
  338.   TO/A      zipcode basename (1!<basename>, 2!<basename>, etc...)
  339.   DEVICE/N  1541 device number
  340.   DEBUG/S   sets debug mode (shows all packets).
  341.  
  342. Reads an entire disk from the 1541 and encodes it into a standard
  343. zipcode archive.
  344. This may sometimes produce shorter archives than zipcode, but the
  345. archive will unpack fine on the c64.
  346.  
  347.  
  348.  
  349. command SERVER:
  350. ---------------
  351.  
  352. TEMPLATE: Over5 SERVER DEBUG/S
  353.  
  354.   DEBUG/S   sets debug mode (shows all packets).
  355.  
  356. Sets the amiga in SERVER MODE.  Run 'SerFile' on the c64 to use it.
  357.  
  358. commands (#C"<COMMAND>" or .<COMMAND> in 'SerFile')
  359.  
  360. .DIR or .$ or $
  361.   Displays the files in the current directory.
  362.  
  363. .CD
  364.   Displays the name of the current directory.
  365.  
  366. .CD <dir>
  367.   Set the current directory to <dir>.
  368.  
  369.  
  370.  
  371. command HELP:
  372. -------------
  373.  
  374. TEMPLATE: Over5 HELP or Over5 ?
  375.  
  376. Shows small help text.
  377.  
  378.  
  379.  
  380. System requirements:
  381.  
  382.   Over5 should run on any system setup running OS2.04 or higher, although it
  383. has only been tested on an A3000/25 running OS3.1.  If you find bugs or have
  384. suggestions about how to make the program better please send a bugreport or
  385. a list of suggestions to the address at the end of this text.
  386.  
  387. -----------------------------------------------------------------------------
  388.  
  389. Author:
  390.  
  391.   Daniel Kahlin is a student at the Royal Institute of Technology (Stockholm)
  392. Former c64 demo programmer (1986-1988).  He is deeply involved with computers
  393. and electronics.
  394.  
  395.    InterNet:  <tlr@stacken.kth.se>
  396.  
  397.   SnailMail:  Daniel Kahlin
  398.               Vanadisvägen 6, 2tr
  399.               s-113 46 Stockholm
  400.               Sweden
  401.  
  402.       Phone:  08-34 84 73 (+468348473)
  403.  
  404. -----------------------------------------------------------------------------
  405.  
  406.